// Licensed to Cloudera, Inc. under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  Cloudera, Inc. licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.cloudera.csd.descriptors;

import com.cloudera.csd.descriptors.InterfaceStability.Unstable;
import com.cloudera.csd.validation.constraints.MetricEntityAttributeNameFormat;
import com.cloudera.csd.validation.references.annotations.Named;

import org.hibernate.validator.constraints.NotEmpty;

/**
 * Describes an possible attribute of a metric entity type.
 */
@Unstable
@Named
public interface MetricEntityAttributeDescriptor {

  /**
   * Returns the name of the attribute. This name uniquely identifies this
   * attribute and is used to reference the metric in the Cloudera Manager
   * API and charting features.
   * @return
   */
  @MetricEntityAttributeNameFormat
  String getName();

  /**
   * Returns the display name of the attribute.
   * @return
   */
  @NotEmpty
  String getLabel();

  /**
   * Returns the description of the attribute.
   * @return
   */
  @NotEmpty
  String getDescription();

  /**
   * Returns whether to treat attribute values as case-sensitive.
   * @return
   */
  boolean isValueCaseSensitive();
}
